NAVNavbar
Logo
php python csharp java

Setting Live ‘Ads Traffic By Keywords’ Tasks

‌‌
You can receive a set of stats for daily impressions, CPC and clicks estimation. This data is really useful for estimating real demand for a specific keyword, as it is much more accurate than the regular search volume information, which shows the broad match estimation for a group of similar keywords.

If your system requires delivering instant results, the Live method is the best solution for you. Unlike the Standard method, this method doesn’t require making separate POST and GET requests to the corresponding endpoints.

If you don’t need to receive data in real-time, you can use the Standard method of data retrieval. This method requires making separate POST and GET requests, but it’s more affordable. Using this method you can retrieve the results after our system collects them.

You can also check the update status of keywords search volume returned by Google API using the Get AdWords Status endpoint.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
try {
	// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
	$client = new RestClient($api_url, null, 'login', 'password');
} catch (RestClientException $e) {
	echo "\n";
	print "HTTP code: {$e->getHttpCode()}\n";
	print "Error code: {$e->getCode()}\n";
	print "Message: {$e->getMessage()}\n";
	print  $e->getTraceAsString();
	echo "\n";
	exit();
}
$post_array = array();
// simple way to set a task
$post_array[] = array(
	"location_name" => "United States",
	"language_name" => "English",
	"bid" => 999.00,
	"match" => "exact",
	"keywords" => array(
		"seo marketing"
	)
);
try {
	// POST /v3/keywords_data/google/ad_traffic_by_keywords/live
	// the full list of possible parameters is available in documentation
	$result = $client->post('/v3/keywords_data/google/ad_traffic_by_keywords/live', $post_array);
	print_r($result);
	// do something with post result
} catch (RestClientException $e) {
	echo "\n";
	print "HTTP code: {$e->getHttpCode()}\n";
	print "Error code: {$e->getCode()}\n";
	print "Message: {$e->getMessage()}\n";
	print  $e->getTraceAsString();
	echo "\n";
}
$client = null;
?>

The above command returns JSON structured like this:

{
  "version": "3.20191128",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "1.5868 sec.",
  "cost": 0.075,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "11211007-0696-0094-0000-b5b4b12c78bb",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "1.5131 sec.",
      "cost": 0.075,
      "result_count": 1,
      "path": [
        "v3",
        "keywords_data",
        "google",
        "ad_traffic_by_keywords",
        "live"
      ],
      "data": {
        "api": "keywords_data",
        "function": "ad_traffic_by_keywords",
        "se": "google",
        "language_code": "en",
        "location_code": 2840,
        "bid": 999,
        "match": "exact",
        "keywords": [
          "seo marketing"
        ]
      },
      "result": [
        {
          "language_code": "en",
          "location_code": 2840,
          "bid": 999,
          "keyword": "seo marketing",
          "match": "exact",
          "ad_position_min": 1.11,
          "ad_position_max": 1,
          "ad_position_average": 1.06,
          "cpc_min": 38.86,
          "cpc_max": 47.5,
          "cpc_average": 43.18,
          "daily_impressions_min": 140.29,
          "daily_impressions_max": 171.47,
          "daily_impressions_average": 155.88,
          "daily_clicks_min": 1.14,
          "daily_clicks_max": 1.39,
          "daily_clicks_average": 1.27,
          "daily_cost_min": 49.2,
          "daily_cost_max": 60.13,
          "daily_cost_average": 54.67
        }
      ]
    }
  ]
}

All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute.

You will get information for every single keyword in an array. You can send up to 2500 keywords in one keywords array. Our system will charge your account per request, no matter what number of keywords an array has, the price for 1 or 2500 keywords will be the same.

Below you will find a detailed description of the fields you can use for setting a task.

Description of the fields for setting a task:

Field name Type Description
keywords array keywords
required field
the maximum number of keywords you can specify: 2500
the maximum number of characters for each keyword: 80
the maximum number of words for each keyword phrase: 10
the specified keywords will be converted to lowercase, data will be provided in a separate array;
bid float the maximum custom bid
required field
the collected data will be based on this value
it stands for the price you are willing to pay for an ad; the higher value you specify, the higher positions and price you will get
match string keywords match-type
required field
can take the following values: exact, broad, phrase
location_name string full name of search engine location
optional field
if you use this field, you don’t need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/keywords_data/google/locations
ignore this field to receive global results
example:
London,England,United Kingdom
location_code integer search engine location code
optional field
if you use this field, you don’t need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/google/locations
ignore this field to receive global results
example:
2840
location_coordinate string GPS coordinates of a location
optional field
if you use this field, you don’t need to specify location_name or location_code
location_coordinate parameter should be specified in the “latitude,longitude” format
the data will be provided for the country the specified coordinates belong to
ignore this field to receive global results
example:
52.6178549,-155.352142
language_name string full name of search engine language
optional field if you specify language_code
if you use this field, you don’t need to specify language_code
you can receive the list of available locations of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/keywords_data/google/languages
example:
English
language_code string search engine language code
optional field if you specify language_name
if you use this field, you don’t need to specify language_name
you can receive the list of available locations of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/google/languages
example:
en
tag string user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data array of the response

‌‌
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Description of the fields in the result array:

version string the current version of the API
status_code integer general status code
you can find the full list of the response codes here
status_message string general informational message
you can find the full list of general informational messages here
time string execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasks array
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string task identifier
unique task identifier in our system in the UUID format
        status_code integer status code of the task
generated by DataForSEO; can be within the following range: 10000-60000
you can find the full list of response codes here
        status_message string informational message of the task
you can find the full list of general informational messages here
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data array contains the same parameters that you specified in the POST request
        result array array of results
            location_code integer location code in a POST array
if there is no data, then the value is null
            language_code string language code in a POST array
if there is no data, then the value is null
            bid float the maximum custom bid
the bid you have specified when setting the task
represents the price you are willing to pay for an ad
the higher value you have specified, the higher positions and price you receive in response
            keyword string keyword
keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
            match string keywords match-type
can take the following values: exact, broad, phrase
            ad_position_min float the minimum ad position
represents the minimum position of the advertisement
if there is no data, then the value is null
            ad_position_max float the maximum ad position
represents the maximum position of the advertisement
if there is no data, then the value is null
            ad_position_average float the average ad position
represents the average position of the advertisement
if there is no data, then the value is null
            cpc_min float the minimum value of cost-per-click
represents the minimum cost-per-click (USD) historically paid for the keyword
if there is no data, then the value is null
            cpc_max float the maximum value of cost-per-click
represents the maximum cost-per-click (USD) historically paid for the keyword
if there is no data, then the value is null
            cpc_average float the average value of cost-per-click
represents the average cost-per-click (USD) historically paid for the keyword
if there is no data, then the value is null
            daily_impressions_min float the minimum value of daily impressions
represents the minimum number of daily impressions of the advertisement
if there is no data, then the value is null
            daily_impressions_max float the maximum value of daily impressions
represents the maximum number of daily impressions of the advertisement
if there is no data, then the value is null
            daily_impressions_average float the average value of daily impressions
represents the average number number of daily impressions of the advertisement
if there is no data, then the value is null
            daily_clicks_min float the minimum value of daily clicks
represents the minimum number of daily clicks on the advertisement
if there is no data, then the value is null
            daily_clicks_max float the maximum value of daily clicks
represents the maximum number of daily clicks on the advertisement
if there is no data, then the value is null
            daily_clicks_average float the average value of daily clicks
represents the average number of daily clicks on the advertisement
if there is no data, then the value is null
            daily_cost_min float the minimum daily charge value
represents the minimum daily charge for the advertisement
if there is no data, then the value is null
            daily_cost_max float the maximum daily charge value
represents the maximum daily charge for the advertisement
if there is no data, then the value is null
            daily_cost_average float the average daily charge value
represents the average daily charge for the advertisement
if there is no data, then the value is null

‌‌